SftTree/OCX 7.0

SftTree.DisplayColumn Property

Softel vdm, Inc.

Returns the display column number given a real column number.

Deprecated - Provided for compatibility with earlier versions only - Use Column.DisplayPosition or ColumnsObj.DisplayPosition instead

Syntax       

Get

VB.NET

DispColIndex = object.get_DisplayColumn(ByVal ColIndex As Short)  As Short

VB

DispColIndex = object.DisplayColumn(ByVal ColIndex As Integer)  As Integer

C#.NET

short DispColIndex = object.get_DisplayColumn(short ColIndex);

VC++

short DispColIndex = object->DisplayColumn[short ColIndex];
short DispColIndex = object->GetDisplayColumn(short ColIndex);

C

HRESULT object->get_DisplayColumn(short ColIndex, short* DispColIndex);

Delphi

DispColIndex := object.DisplayColumn[ColIndex : Smallint]   : Smallint;

object

A SftTree object.

ColIndex

The zero-based column number.

DispColIndex

Returns the display column number given a real column number.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Column.DisplayPosition or ColumnsObj.DisplayPosition instead

The DisplayColumn property returns the display column number given a real column number.

As a user reorders columns, this is completely transparent to the application.  An application still references cells and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user.  While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.

If a user reorders columns using column drag & drop, the (real) column numbers used by an application may need to be translated into the actual display column number, which is the column number as it appears to the user.

The ColumnsObj.Move method can be used to reorder columns under program control.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com